Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

aap-14811 Added modules for section 4.5 #812

Merged
merged 7 commits into from
Jul 5, 2024

Conversation

emurtoug
Copy link
Contributor

@emurtoug emurtoug commented Nov 23, 2023

AAP-14811

Added the following modules for Chapter 3 of Red Hat Ansible Automation Platform Hardening Guide v2.5:

  • new file: assembly-aap-security-use-cases.adoc
  • new file: con-aap-patch-automation.adoc
  • new file: con-patch-automation.adoc
  • new file: ref-patching-examples.adoc
  • ref-installing-security-updates-only.adoc
  • ref-keeping-everything-up-to-date.adoc
  • ref-specifying-package-versions.adoc

Updated:

  • titles/aap-hardening/master.adoc

Deleted:

  • assembly-aap-security-enabling.adoc (replaced with assembly-aap-security-use-cases.adoc)

@lmalivert lmalivert added AAP Hardening Content applies to AAP hardening Draft Draft / work in progress: do not merge labels Nov 29, 2023
@emurtoug emurtoug changed the base branch from main to aap-hardening-2.5 November 30, 2023 12:06
ariordan-redhat pushed a commit to ariordan-redhat/aap-docs that referenced this pull request Mar 22, 2024

[role="_abstract"]

Software patching is a fundamental activity of security and IT operations teams everywhere. Keeping patches up to date is critical to remediating software vulnerabilities and meeting compliance requirements, but patching systems manually at scale can be a time-consuming and error-prone process. Organizations should put thought into patch management strategies that meet their security, compliance, and business objectives, in order to prioritize the types of patches to apply (known exploits, critical or important vulnerabilities, optimizations, routine updates, new features, and so on) against the IT assets available across the enterprise.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Software patching is a fundamental activity of security and IT operations teams everywhere. Keeping patches up to date is critical to remediating software vulnerabilities and meeting compliance requirements, but patching systems manually at scale can be a time-consuming and error-prone process. Organizations should put thought into patch management strategies that meet their security, compliance, and business objectives, in order to prioritize the types of patches to apply (known exploits, critical or important vulnerabilities, optimizations, routine updates, new features, and so on) against the IT assets available across the enterprise.
Software patching is a fundamental activity of security and IT operations teams everywhere.
Keeping patches up to date is critical to remediating software vulnerabilities and meeting compliance requirements, but patching systems manually at scale can be a time-consuming and error-prone process.
Organizations should put thought into patch management strategies that meet their security, compliance, and business objectives, in order to prioritize the types of patches to apply (known exploits, critical or important vulnerabilities, optimizations, routine updates, new features, and so on) against the IT assets available across the enterprise.


Software patching is a fundamental activity of security and IT operations teams everywhere. Keeping patches up to date is critical to remediating software vulnerabilities and meeting compliance requirements, but patching systems manually at scale can be a time-consuming and error-prone process. Organizations should put thought into patch management strategies that meet their security, compliance, and business objectives, in order to prioritize the types of patches to apply (known exploits, critical or important vulnerabilities, optimizations, routine updates, new features, and so on) against the IT assets available across the enterprise.

Once policies and priorities have been defined and a patching plan is established, the manual tasks involved in patch management can be automated using the {PlatformNameShort} to improve patch deployment speed and accuracy, reduce human error, and limit downtime.
Copy link
Contributor

@ariordan-redhat ariordan-redhat Jun 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Once policies and priorities have been defined and a patching plan is established, the manual tasks involved in patch management can be automated using the {PlatformNameShort} to improve patch deployment speed and accuracy, reduce human error, and limit downtime.
Once you have defined policies and priorities and established a patching plan, you can automate the manual patch management tasks using the {PlatformNameShort}.
Automating the tasks improves patch deployment speed and accuracy, reduces human error, and limits downtime.


[role="_abstract"]

For organizations with a policy requiring that all RPMs including security errata be kept up to date, the following playbook might be used in a regularly scheduled job template.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For organizations with a policy requiring that all RPMs including security errata be kept up to date, the following playbook might be used in a regularly scheduled job template.
If your organization has a policy requiring that all RPMs including security errata be kept up to date, you can use the following playbook in a regularly scheduled job template.

Best to avoid "might" in technical docs


[role="_abstract"]

For some RHEL servers, such as a lab or other non-production systems, there may be a desire to install all available patches on a regular cadence. The following example playbook might be used in a job template that is scheduled to run weekly, and will update the system with all of the latest RPMs.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For some RHEL servers, such as a lab or other non-production systems, there may be a desire to install all available patches on a regular cadence. The following example playbook might be used in a job template that is scheduled to run weekly, and will update the system with all of the latest RPMs.
For some RHEL servers, such as a lab or other non-production systems, administrators might want to install all available patches on a regular cadence.
The following example playbook can be used in a job template that is scheduled to run weekly. It updates the system with all of the latest RPMs.

{PlatformName} can connect your security teams, tools, and processes for more successful automation adoption and use.
Learn how automation can help you safeguard your business and respond to growing security threats faster.

link:https://www.redhat.com/en/resources/security-automation-ebook[Simplify your security operations center] provides an overview of the benefits to automating SOC operations, including use cases such as:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be useful to tell the reader that this is a Red Hat e-book?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That sounds good to me! What do you think of something like: "For more information on the benefits of automating SOC operations, including use cases, see the Red Hat E-book link:https://www.redhat.com/en/resources/security-automation-ebook[_Simplify your security operations center_]. @ariordan-redhat


Automating the patching process provides a number of benefits:

* Reduce error-prone manual effort.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Reduce error-prone manual effort.
* Reduces error-prone manual effort.

Automating the patching process provides a number of benefits:

* Reduce error-prone manual effort.
* Decrease time to deploy patches at scale.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Decrease time to deploy patches at scale.
* Decreases time to deploy patches at scale.


[role="_abstract"]

For production systems, it is a well-established configuration management practice to deploy only known, tested combinations of software in order to ensure that systems are configured correctly and perform as expected.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For production systems, it is a well-established configuration management practice to deploy only known, tested combinations of software in order to ensure that systems are configured correctly and perform as expected.
For production systems, it is a well-established configuration management practice to deploy only known, tested combinations of software to ensure that systems are configured correctly and perform as expected.


For production systems, it is a well-established configuration management practice to deploy only known, tested combinations of software in order to ensure that systems are configured correctly and perform as expected.
This includes deploying only known versions of operating system software and patches to ensure that system updates do not introduce problems with production applications.
The following example playbook will install a specific version of the httpd RPM and its dependencies when the target host uses the RHEL 9 operating system.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The following example playbook will install a specific version of the httpd RPM and its dependencies when the target host uses the RHEL 9 operating system.
The following example playbook installs a specific version of the `httpd` RPM and its dependencies when the target host uses the RHEL 9 operating system.


In {PlatformNameShort}, multiple automation jobs can be chained together into workflows, which can be used to coordinate multiple steps in a complex patching scenario.

In the following example complex patching scenario demonstrates taking virtual machine snapshots, patching the virtual machines, and creating tickets when an error is encountered in the workflow.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In the following example complex patching scenario demonstrates taking virtual machine snapshots, patching the virtual machines, and creating tickets when an error is encountered in the workflow.
The following example complex patching scenario demonstrates taking virtual machine snapshots, patching the virtual machines, and creating tickets when an error is encountered in the workflow.

Copy link
Contributor

@ariordan-redhat ariordan-redhat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ariordan-redhat ariordan-redhat merged commit 9fa9a8e into ansible:aap-hardening-2.5 Jul 5, 2024
@emurtoug emurtoug added Peer review complete This PR is reviewed and approved by members of the docs team 2.5 Content applies to AAP 2.5 Needs backport to 2.5 Changes still need to be applied to the AAP 2.5 branch Ready for technical review Content is ready for technical reviews labels Jul 5, 2024
[role="_abstract"]

The following set of defensive security controls are recommended to reduce operational risk of {PlatformNameShort} deployed on physical or virtual machines.
These controls apply to all of the {PlatformNameShort} infrastructure nodes: the dedicated installation host, and any servers listed in the installation inventory such as controllers, hubs, EDA controllers, and the database server.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for "controllers, hubs, and EDA controllers" I would recommend checking with branding to get the name/shortname of each of these and probably parameterize them similar to PlatformName/PlatformNameShort. Maybe something to do in another PR?

Comment on lines +29 to +49
.. In {ControllerName}, create the file `/etc/audit/rules.d/75-automation-controller.rules` with the following content, then run `augenrules --load` to load the new rules:

-----
-w /etc/tower/ -p warx -k aap-aac-mon-confdir
-w /etc/supervisord.conf -p warx -k aap-aac-mon-supervisord
-w /etc/supervisord.d/ -p warx -k aap-aac-mon-supervisord
-w /etc/nginx/ -p warx -k aap-aac-mon-nginx
-w /etc/receptor/ -p war -k aap-aac-mon-receptor
-w /etc/redis/ -p war -k aap-aac-mon-redis
-----

. In {HubName}, create the file `/etc/audit/rules.d/75-automation-hub.rules` with the following content, then run `augenrules --load` to load the new rules:

-----
-w /etc/pulp/ -p warx -k aap-hub-mon-confdir
-w /etc/redis/ -p war -k aap-hub-mon-redis
-w /etc/nginx/ -p warx -k aap-hub-mon-nginx
-----

[NOTE]
If the audit rules are set to be immutable (that is, `-e 2` is set in `/etc/audit/audit.rules`), a reboot will be required for the new audit rules to take effect.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did this procedure go through technical QA? it worked on a test system i built, but formal QA would be better.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.5 Content applies to AAP 2.5 AAP Hardening Content applies to AAP hardening Draft Draft / work in progress: do not merge Needs backport to 2.5 Changes still need to be applied to the AAP 2.5 branch Peer review complete This PR is reviewed and approved by members of the docs team Ready for technical review Content is ready for technical reviews
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants